<!doctype html>


<html>
<head>
  <link rel="shortcut icon" href="static/images/favicon.ico" type="image/x-icon">
  <title>iframe.js (Closure Library API Documentation - JavaScript)</title>
  <link rel="stylesheet" href="static/css/base.css">
  <link rel="stylesheet" href="static/css/doc.css">
  <link rel="stylesheet" href="static/css/sidetree.css">
  <link rel="stylesheet" href="static/css/prettify.css">

  <script>
     var _staticFilePath = "static/";
     var _typeTreeName = "goog";
     var _fileTreeName = "Source";
  </script>

  <script src="static/js/doc.js">
  </script>


  <meta charset="utf8">
</head>

<body onload="grokdoc.onLoad();">

<div id="header">
  <div class="g-section g-tpl-50-50 g-split">
    <div class="g-unit g-first">
      <a id="logo" href="index.html">Closure Library API Documentation</a>
    </div>

    <div class="g-unit">
      <div class="g-c">
        <strong>Go to class or file:</strong>
        <input type="text" id="ac">
      </div>
    </div>
  </div>
</div>





<div class="colmask rightmenu">
<div class="colleft">
    <div class="col1">
      <!-- Column 1 start -->

<div id="title">
       <span class="fn">iframe.js</span>
</div>

<div class="g-section g-tpl-75-25">
  <div class="g-unit g-first" id="description">
    <span class='nodesc'>No description.</span>
  </div>
  

        <div class="g-unit" id="useful-links">
          <div class="title">Useful links</div>
          <ol>
            <li><a href="local_closure_goog_dom_iframe.js.source.html"><span class='source-code-link'>Source Code</span></a></li>
            <li><a href="http://code.google.com/p/closure-library/source/browse/local/closure/goog/dom/iframe.js">Git</a></li>
          </ol>
        </div>
</div>

<h2 class="g-first">File Location</h2>
  <div class="g-section g-tpl-20-80">
    <div class="g-unit g-first">
      <div class="g-c-cell code-label">/goog/dom/iframe.js</div>
    </div>
  </div>
<hr/>


   
<br/>

  <div class="legend">
        <span class="key publickey"></span><span>Public</span>
        <span class="key protectedkey"></span><span>Protected</span>
        <span class="key privatekey"></span><span>Private</span>
  </div>









<div class="section">
  <table class="horiz-rule">


  </table>
</div>




  <h2>Global Functions</h2>





<div class="section">
  <table class="horiz-rule">


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.iframe.createBlank"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.dom.iframe.</span><span class="entryName">createBlank<span class="args">(<span class="arg">domHelper</span>,&nbsp;<span class="arg">opt_styles</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type">HTMLIFrameElement</span>
      </div>


     <div class="entryOverview">
       Creates a completely blank iframe element.

The iframe will not caused mixed-content warnings for IE6 under HTTPS.
The iframe will also have no borders or padding, so that the styled width
and height will be the actual width and height of the iframe.

This function currently only attempts to create a blank iframe.  There
are no guarantees to the contents of the iframe or whether it is rendered
in quirks mode.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">domHelper</span>
        : <span class="type"><a href="class_goog_dom_DomHelper.html">goog.dom.DomHelper</a></span>
        <div class="entryOverview">The dom helper to use.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_styles</span>
        : <span class="type">string=</span>
        <div class="entryOverview">CSS styles for the iframe.</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type">HTMLIFrameElement</span>&nbsp;
            A completely blank iframe.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_iframe.js.source.html#line95">code &raquo;</a>
  </td>
     </tr>


     <tr class="odd entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.iframe.createWithContent"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.dom.iframe.</span><span class="entryName">createWithContent<span class="args">(<span class="arg">parentElement</span>,&nbsp;<span class="arg">opt_headContents</span>,&nbsp;<span class="arg">opt_bodyContents</span>,&nbsp;<span class="arg">opt_styles</span>,&nbsp;<span class="arg">opt_quirks</span>)</span>
        </span>
        &#8658; <span>!</span><span class="type">HTMLIFrameElement</span>
      </div>


     <div class="entryOverview">
       Creates a same-domain iframe containing preloaded content.

This is primarily useful for DOM sandboxing.  One use case is to embed
a trusted Javascript app with potentially conflicting CSS styles.  The
second case is to reduce the cost of layout passes by the browser -- for
example, you can perform sandbox sizing of characters in an iframe while
manipulating a heavy DOM in the main window.  The iframe and parent frame
can access each others' properties and functions without restriction.


     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">parentElement</span>
        : <span>!</span><span class="type"><a href="https://developer.mozilla.org/en/DOM/Element">Element</a></span>
        <div class="entryOverview">The parent element in which to append the
    iframe.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_headContents</span>
        : <span class="type">string=</span>
        <div class="entryOverview">Contents to go into the iframe's head.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_bodyContents</span>
        : <span class="type">string=</span>
        <div class="entryOverview">Contents to go into the iframe's body.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">opt_styles</span>
        : <span class="type">string=</span>
        <div class="entryOverview">CSS styles for the iframe itself, before adding
    to the parent element.</div>
     </td>
   </tr>
     
   <tr class="even">
     <td>
        <span class="entryName">opt_quirks</span>
        : <span class="type">boolean=</span>
        <div class="entryOverview">Whether to use quirks mode (false by default).</div>
     </td>
   </tr>
  </table>
      </div>
   
      <div class="detailsSection">
        <b>Returns:</b>&nbsp;<span>!</span><span class="type">HTMLIFrameElement</span>&nbsp;
            An iframe that has the specified contents.
      </div>
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_iframe.js.source.html#line144">code &raquo;</a>
  </td>
     </tr>


     <tr class="even entry public">
       <td class="access"></td>






  <td>
    <a name="goog.dom.iframe.writeContent"></a>


     <div class="arg">
       <img align="left" src="static/images/blank.gif">

        <span class="entryNamespace">goog.dom.iframe.</span><span class="entryName">writeContent<span class="args">(<span class="arg">iframe</span>,&nbsp;<span class="arg">content</span>)</span>
        </span>
      </div>


     <div class="entryOverview">
       Writes the contents of a blank iframe that has already been inserted
into the document.

     </div>


    <! -- Method details -->
    <div class="entryDetails">

      <div class="detailsSection">
        <b>Arguments: </b>






<table class="horiz-rule">
     
   <tr class="even">
     <td>
        <span class="entryName">iframe</span>
        : <span>!</span><span class="type">HTMLIFrameElement</span>
        <div class="entryOverview">An iframe with no contents, such as
    one created by goog.dom.iframe.createBlank, but already appended to
    a parent document.</div>
     </td>
   </tr>
     
   <tr class="odd">
     <td>
        <span class="entryName">content</span>
        : <span class="type"><a href="https://developer.mozilla.org/en/Core_JavaScript_1.5_Reference/Global_Objects/String">string</a></span>
        <div class="entryOverview">Content to write to the iframe, from doctype to
    the HTML close tag.</div>
     </td>
   </tr>
  </table>
      </div>
   
  
    </div>
   
  </td>


  <td class="view-code">
     <a href="local_closure_goog_dom_iframe.js.source.html#line115">code &raquo;</a>
  </td>
     </tr>


  </table>
</div>






      <!-- Column 1 end -->
    </div>

        <div class="col2">
          <!-- Column 2 start -->
          <div class="col2-c">
            <h2 id="ref-head">Directory dom</h2>
            <div id="localView"></div>
          </div>

          <div class="col2-c">
            <h2 id="ref-head">File Reference</h2>
            <div id="sideFileIndex" rootPath="" current="/goog/dom/iframe.js"></div>
          </div>
          <!-- Column 2 end -->
        </div>
</div>
</div>

</body>
</html>
